{resourceProviderNamespace} (stable:2015-11-01)

2025/12/05 • 37 new, 37 deleted methods

Providers_Unregister (new)
Description :  Unregisters provider from a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_Register (new)
Description :  Registers provider to be used with a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_List (new)
Description :  Gets a list of resource providers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$top:
{
Description: Query parameters. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: False ,
}
string ,
}
Providers_Get (new)
Description :  Gets a resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
ResourceGroups_ListResources (new)
Description :  Get all of the resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource groups. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
ResourceGroups_CheckExistence (new)
Description :  Checks whether resource group exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to check. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
ResourceGroups_CreateOrUpdate (new)
Description :  Create a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update resource group service operation. ,
Required: True ,
}
{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Delete (new)
Description :  Begin deleting resource group.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be deleted. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ResourceGroups_Get (new)
Description :  Get a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Patch (new)
Description :  Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update state resource group service operation. ,
Required: True ,
}
{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_List (new)
Description :  Gets a collection of resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource groups. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
Resources_MoveResources (new)
Description :  Begin moving resources.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: Source resource group name. ,
Required: True ,
}
string ,
parameters:
{
Description: move resources' parameters. ,
Required: True ,
}
{
resources:
{
Description: Gets or sets the ids of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_List (new)
Description :  Get all of the resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource groups. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
Resources_CheckExistence (new)
Description :  Checks whether resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_Delete (new)
Description :  Delete resource and all of its resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_CreateOrUpdate (new)
Description :  Create a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
parameters:
{
Description: Create or update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
Resources_Update (new)
Description :  Updates a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to update. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating the resource. ,
Required: True ,
}
{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}
Resources_Get (new)
Description :  Returns a resource belonging to a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}

⚐ Response (204)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
Tags_DeleteValue (new)
Description :  Delete a subscription resource tag value.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_CreateOrUpdateValue (new)
Description :  Create a subscription resource tag value.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
Tags_CreateOrUpdate (new)
Description :  Create a subscription resource tag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: Gets or sets the tag name. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
values:
{
Description: Gets or sets the list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: Gets or sets the tag name. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
values:
{
Description: Gets or sets the list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Tags_Delete (new)
Description :  Delete a subscription resource tag.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_List (new)
Description :  Get a list of subscription resource tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of tags. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: Gets or sets the tag name. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
values:
{
Description: Gets or sets the list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
ResourceProviderOperationDetails_List (new)
Description :  Gets a list of resource providers.
Reference :  Link ¶

⚼ Request

GET:  /providers/{resourceProviderNamespace}/operations
{
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource provider operations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the provider operation name. ,
Required: False ,
}
string ,
display:
{
Description: Gets or sets the display property of the provider operation. ,
Required: False ,
}
{
publisher:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets operation provider. ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets operation resource. ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets operation. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
value:
{
Description: Gets or sets the list of resource provider operations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the provider operation name. ,
Required: False ,
}
string ,
display:
{
Description: Gets or sets the display property of the provider operation. ,
Required: False ,
}
{
publisher:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets operation provider. ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets operation resource. ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets operation. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}
PolicyDefinitions_CreateOrUpdate (new)
Description :  Create or update policy definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The policy definition name. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy definition properties ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the policy definition properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the policy definition description. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy definition display name. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule json. ,
Required: False ,
}
object ,
}
,
name:
{
Description: Gets or sets the policy definition name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the policy definition properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the policy definition description. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy definition display name. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule json. ,
Required: False ,
}
object ,
}
,
name:
{
Description: Gets or sets the policy definition name. ,
Required: False ,
}
string ,
}
PolicyDefinitions_Get (new)
Description :  Gets policy definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The policy definition name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy definition properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the policy definition description. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy definition display name. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule json. ,
Required: False ,
}
object ,
}
,
name:
{
Description: Gets or sets the policy definition name. ,
Required: False ,
}
string ,
}
PolicyDefinitions_Delete (new)
Description :  Deletes policy definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The policy definition name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
PolicyAssignments_ListForResource (new)
Description :  Gets policy assignments of the resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource path. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForResourceGroup (new)
Description :  Gets policy assignments of the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: Resource group name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
PolicyAssignments_Delete (new)
Description :  Delete policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: Policy assignment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_Create (new)
Description :  Create policy assignment.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: Policy assignment name. ,
Required: True ,
}
string ,
parameters:
{
Description: Policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_Get (new)
Description :  Get single policy assignment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: Policy assignment name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_DeleteById (new)
Description :  Delete policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: Policy assignment Id ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_CreateById (new)
Description :  Create policy assignment by Id.
Reference :  Link ¶

⚼ Request

PUT:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: Policy assignment Id ,
Required: True ,
}
string ,
parameters:
{
Description: Policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_GetById (new)
Description :  Get single policy assignment.
Reference :  Link ¶

⚼ Request

GET:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: Policy assignment Id ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_List (new)
Description :  Gets policy assignments of the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForScope (new)
Description :  Gets policy assignments of the scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
Providers_Unregister (removed)
Description :  Unregisters provider from a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_Register (removed)
Description :  Registers provider to be used with a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_List (removed)
Description :  Gets a list of resource providers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$top:
{
Description: Query parameters. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: False ,
}
string ,
}
Providers_Get (removed)
Description :  Gets a resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: Gets or sets the namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: Gets or sets the registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: Gets or sets the collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: Gets or sets the resource type. ,
Required: False ,
}
string ,
locations:
{
Description: Gets or sets the collection of locations where this resource type can be created in. ,
Required: False ,
}
[
string ,
]
,
apiVersions:
{
Description: Gets or sets the api version. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
object ,
}
,
]
,
}
ResourceGroups_ListResources (removed)
Description :  Get all of the resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource groups. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
ResourceGroups_CheckExistence (removed)
Description :  Checks whether resource group exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to check. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
ResourceGroups_CreateOrUpdate (removed)
Description :  Create a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update resource group service operation. ,
Required: True ,
}
{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Delete (removed)
Description :  Begin deleting resource group.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be deleted. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ResourceGroups_Get (removed)
Description :  Get a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Patch (removed)
Description :  Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update state resource group service operation. ,
Required: True ,
}
{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_List (removed)
Description :  Gets a collection of resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource groups. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets resource group provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
Resources_MoveResources (removed)
Description :  Begin moving resources.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: Source resource group name. ,
Required: True ,
}
string ,
parameters:
{
Description: move resources' parameters. ,
Required: True ,
}
{
resources:
{
Description: Gets or sets the ids of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_List (removed)
Description :  Get all of the resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource groups. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
Resources_CheckExistence (removed)
Description :  Checks whether resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_Delete (removed)
Description :  Delete resource and all of its resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_CreateOrUpdate (removed)
Description :  Create a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
parameters:
{
Description: Create or update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
Resources_Update (removed)
Description :  Updates a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to update. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating the resource. ,
Required: True ,
}
{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}
Resources_Get (removed)
Description :  Returns a resource belonging to a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}

⚐ Response (204)

{
plan:
{
Description: Gets or sets the plan of the resource. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: Gets or sets the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Gets or sets the offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: Gets or sets the promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets the resource properties. ,
Required: False ,
}
object ,
}
Tags_DeleteValue (removed)
Description :  Delete a subscription resource tag value.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_CreateOrUpdateValue (removed)
Description :  Create a subscription resource tag value.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
Tags_CreateOrUpdate (removed)
Description :  Create a subscription resource tag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: Gets or sets the tag name. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
values:
{
Description: Gets or sets the list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: Gets or sets the tag name. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
values:
{
Description: Gets or sets the list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Tags_Delete (removed)
Description :  Delete a subscription resource tag.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_List (removed)
Description :  Get a list of subscription resource tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of tags. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: Gets or sets the tag name. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
values:
{
Description: Gets or sets the list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: Gets or sets the tag value. ,
Required: False ,
}
string ,
count:
{
Description: Gets or sets the tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
ResourceProviderOperationDetails_List (removed)
Description :  Gets a list of resource providers.
Reference :  Link ¶

⚼ Request

GET:  /providers/{resourceProviderNamespace}/operations
{
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of resource provider operations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the provider operation name. ,
Required: False ,
}
string ,
display:
{
Description: Gets or sets the display property of the provider operation. ,
Required: False ,
}
{
publisher:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets operation provider. ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets operation resource. ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets operation. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
value:
{
Description: Gets or sets the list of resource provider operations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the provider operation name. ,
Required: False ,
}
string ,
display:
{
Description: Gets or sets the display property of the provider operation. ,
Required: False ,
}
{
publisher:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets operation provider. ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets operation resource. ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets operation. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}
PolicyDefinitions_CreateOrUpdate (removed)
Description :  Create or update policy definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The policy definition name. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy definition properties ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the policy definition properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the policy definition description. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy definition display name. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule json. ,
Required: False ,
}
object ,
}
,
name:
{
Description: Gets or sets the policy definition name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the policy definition properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the policy definition description. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy definition display name. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule json. ,
Required: False ,
}
object ,
}
,
name:
{
Description: Gets or sets the policy definition name. ,
Required: False ,
}
string ,
}
PolicyDefinitions_Get (removed)
Description :  Gets policy definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The policy definition name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy definition properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the policy definition description. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy definition display name. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule json. ,
Required: False ,
}
object ,
}
,
name:
{
Description: Gets or sets the policy definition name. ,
Required: False ,
}
string ,
}
PolicyDefinitions_Delete (removed)
Description :  Deletes policy definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The policy definition name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
PolicyAssignments_ListForResource (removed)
Description :  Gets policy assignments of the resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource path. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForResourceGroup (removed)
Description :  Gets policy assignments of the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: Resource group name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
PolicyAssignments_Delete (removed)
Description :  Delete policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: Policy assignment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_Create (removed)
Description :  Create policy assignment.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: Policy assignment name. ,
Required: True ,
}
string ,
parameters:
{
Description: Policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_Get (removed)
Description :  Get single policy assignment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: Policy assignment name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_DeleteById (removed)
Description :  Delete policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: Policy assignment Id ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_CreateById (removed)
Description :  Create policy assignment by Id.
Reference :  Link ¶

⚼ Request

PUT:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: Policy assignment Id ,
Required: True ,
}
string ,
parameters:
{
Description: Policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_GetById (removed)
Description :  Get single policy assignment.
Reference :  Link ¶

⚼ Request

GET:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: Policy assignment Id ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
PolicyAssignments_List (removed)
Description :  Gets policy assignments of the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForScope (removed)
Description :  Gets policy assignments of the scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy assignment list. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the policy assignment properties. ,
Required: False ,
}
{
scope:
{
Description: Gets or sets the policy assignment scope. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the policy assignment display name. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: Gets or sets the policy definition Id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the policy assignment name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of policy assignment results. ,
Required: False ,
}
string ,
}